************
INTRODUCTION
************

This file describes how to generate the Perl wrapper for Melissa DATA's Address Object.


*************
PREREQUISITES
*************

To make use of the Address Object Perl wrapper you will need:

* An installation of Perl. Wrappers have been tested with Perl 5.8 and Perl 5.10. 

* The Melissa DATA Address Object library and data files installed.
	Library = libmdAddr.so
	Data Files = mdAddr.dat, mdAddr.nat, mdAddr.str, mdAddr.lic


You will need to know the location of these items in order to install and run the Perl wrapper.


*************
Installation
*************

Copy the entire folder that contains this README.txt into a local directory on your computer.

*****
Setup
*****

Open BuildWrapper.sh in a text editor. Make sure the path of the installed Address Object library files are declared for mdAddrPath.

	mdAddrPath="The Path To Your AddrObj Directory"

Also, make sure the PerlIncludePath is set correctly to the location of your Perl CORE directory

	PerlIncludePath="The Path To Your Perl CORE Directory"


*******************
Running the Script
*******************

After the paths have been correctly set, run BuildWrapper.sh (sh BuildWrapper.sh). The mdAddrPerlWrapper.so should be successfully generated.

************
Dependencies
************

You will need to allow mdAddrPerlWrapper.so to find libmdAddr.so. You can do this by:

	1. Set LD_LIBRARY_PATH to the directory containing libmdAddr.so. 
		ex: Export LD_LIBRARY_PATH=/DQT/Current

	or

	2. Copy libmdAddr.so into the directory with mdAddrPerlWrapper.so.



************
Sample Code
************

The 'Samples' folder (found two folder levels up) copntains some sample programs that show off the basic functionality of the Address object and also can be used as reference on how to interface with the object.

*******
Updates
*******

The wrapper does not have to be rebuilt for updates. Simply replace Address Object (libmdAddr.so) and the data files. However, if there is a new method, you will need to rebuild the wrapper to use it.


****
Note
****

Here are some general solutions if you run into problems:

Q. I get an error saying "libmdAddr.so: shared object cannot be opened ."
A. This means that mdAddrPerlWrapper.so cannot link to libmdAddr.so. Please following one of the steps in the Setup section above.
 
COPYRIGHT NOTICE

(C) 2014 Melissa Data Corporation. All rights reserved.
